<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilplmi: xplmi_client.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilplmi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xplmi__client_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xplmi_client.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file Contains the client function prototypes, defines and macros. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.00  dd   01/09/24 Initial release
      pre  07/10/24 Added support for configure secure communication command
      pre  09/30/24 Added XPlmi_GetSecureCommStatus API
      pre  01/13/25 Added client API for command to set access status of DDRMC main registers</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ab1f20993bdf14a739d6c75cc390d9c92"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xplmi__client_8h.html#ab1f20993bdf14a739d6c75cc390d9c92">XPLMI_SLR_INDEX_SHIFT</a>&#160;&#160;&#160;(6U)</td></tr>
<tr class="memdesc:ab1f20993bdf14a739d6c75cc390d9c92"><td class="mdescLeft">&#160;</td><td class="mdescRight">&lt; shift constant to place slr id  <a href="#ab1f20993bdf14a739d6c75cc390d9c92">More...</a><br/></td></tr>
<tr class="separator:ab1f20993bdf14a739d6c75cc390d9c92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33713333b1180a603f9a14fb4243125d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xplmi__client_8h.html#a33713333b1180a603f9a14fb4243125d">XPLMI_SLR_INDEX_0</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:a33713333b1180a603f9a14fb4243125d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 0.  <a href="#a33713333b1180a603f9a14fb4243125d">More...</a><br/></td></tr>
<tr class="separator:a33713333b1180a603f9a14fb4243125d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f65b07d28e9fa31f5179138e519e7e0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xplmi__client_8h.html#a6f65b07d28e9fa31f5179138e519e7e0">XPLMI_SLR_INDEX_1</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:a6f65b07d28e9fa31f5179138e519e7e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 1.  <a href="#a6f65b07d28e9fa31f5179138e519e7e0">More...</a><br/></td></tr>
<tr class="separator:a6f65b07d28e9fa31f5179138e519e7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29170505c98ef8134085f3b106341d9c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xplmi__client_8h.html#a29170505c98ef8134085f3b106341d9c">XPLMI_SLR_INDEX_2</a>&#160;&#160;&#160;(2U)</td></tr>
<tr class="memdesc:a29170505c98ef8134085f3b106341d9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 2.  <a href="#a29170505c98ef8134085f3b106341d9c">More...</a><br/></td></tr>
<tr class="separator:a29170505c98ef8134085f3b106341d9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1d85fe274333fdd2cfe49fab897df2d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xplmi__client_8h.html#ae1d85fe274333fdd2cfe49fab897df2d">XPLMI_SLR_INDEX_3</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:ae1d85fe274333fdd2cfe49fab897df2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">SLR Index 3.  <a href="#ae1d85fe274333fdd2cfe49fab897df2d">More...</a><br/></td></tr>
<tr class="separator:ae1d85fe274333fdd2cfe49fab897df2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7e8e7117a32a2207abc17436a82cde25"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga7e8e7117a32a2207abc17436a82cde25">XPlmi_GetDeviceID</a> (XPlmi_ClientInstance *InstancePtr, XLoader_DeviceIdCode *DeviceIdCode)</td></tr>
<tr class="memdesc:ga7e8e7117a32a2207abc17436a82cde25"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to provides Get device id.  <a href="group__xilplmi__client__apis.html#ga7e8e7117a32a2207abc17436a82cde25">More...</a><br/></td></tr>
<tr class="separator:ga7e8e7117a32a2207abc17436a82cde25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87c129257a8fabebacb9f764a4be628d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga87c129257a8fabebacb9f764a4be628d">XPlmi_GetBoard</a> (XPlmi_ClientInstance *InstancePtr, u64 Addr, u32 Size, u32 *ResponseLength)</td></tr>
<tr class="memdesc:ga87c129257a8fabebacb9f764a4be628d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Get board.  <a href="group__xilplmi__client__apis.html#ga87c129257a8fabebacb9f764a4be628d">More...</a><br/></td></tr>
<tr class="separator:ga87c129257a8fabebacb9f764a4be628d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae746051336f43281004be2537db2c3d8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#gae746051336f43281004be2537db2c3d8">XPlmi_TamperTrigger</a> (XPlmi_ClientInstance *InstancePtr, u32 TamperResponse)</td></tr>
<tr class="memdesc:gae746051336f43281004be2537db2c3d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Tamper Trigger.  <a href="group__xilplmi__client__apis.html#gae746051336f43281004be2537db2c3d8">More...</a><br/></td></tr>
<tr class="separator:gae746051336f43281004be2537db2c3d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41f2113dce651f9b36a2abefa10be64c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga41f2113dce651f9b36a2abefa10be64c">XPlmi_EventLogging</a> (XPlmi_ClientInstance *InstancePtr, u32 sub_cmd, u64 Addr, u32 Len)</td></tr>
<tr class="memdesc:ga41f2113dce651f9b36a2abefa10be64c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to Event Logging.  <a href="group__xilplmi__client__apis.html#ga41f2113dce651f9b36a2abefa10be64c">More...</a><br/></td></tr>
<tr class="separator:ga41f2113dce651f9b36a2abefa10be64c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0055868baa98bae19b5d94d65b92189b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga0055868baa98bae19b5d94d65b92189b">XPlmi_ConfigSecureComm</a> (XPlmi_ClientInstance *InstancePtr, XPlmi_SsitSecComm *SsitSecCommDataPtr)</td></tr>
<tr class="memdesc:ga0055868baa98bae19b5d94d65b92189b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to configure secure communication.  <a href="group__xilplmi__client__apis.html#ga0055868baa98bae19b5d94d65b92189b">More...</a><br/></td></tr>
<tr class="separator:ga0055868baa98bae19b5d94d65b92189b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#gaf2f52002fc35d8a8b40cb6dbc5bfc7a3">XPlmi_GetSecureCommStatus</a> (XPlmi_ClientInstance *InstancePtr, u32 SlrIndex, u32 *SecCommStatus)</td></tr>
<tr class="memdesc:gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to get secure communication status.  <a href="group__xilplmi__client__apis.html#gaf2f52002fc35d8a8b40cb6dbc5bfc7a3">More...</a><br/></td></tr>
<tr class="separator:gaf2f52002fc35d8a8b40cb6dbc5bfc7a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73244b8606628c8941215ea3b3e5cc84"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga73244b8606628c8941215ea3b3e5cc84">XPlmi_SetDDRMCMainRegSts</a> (XPlmi_ClientInstance *InstancePtr, u32 DDRMCNum, u32 RegSts)</td></tr>
<tr class="memdesc:ga73244b8606628c8941215ea3b3e5cc84"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to set DDRMC main registers status command.  <a href="group__xilplmi__client__apis.html#ga73244b8606628c8941215ea3b3e5cc84">More...</a><br/></td></tr>
<tr class="separator:ga73244b8606628c8941215ea3b3e5cc84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9aa8c572abe57e4552a86bdf06e5c8e8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xilplmi__client__apis.html#ga9aa8c572abe57e4552a86bdf06e5c8e8">XPlmi_InputSlrIndex</a> (XPlmi_ClientInstance *InstancePtr, u32 SlrIndex)</td></tr>
<tr class="memdesc:ga9aa8c572abe57e4552a86bdf06e5c8e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the SLR Index.  <a href="group__xilplmi__client__apis.html#ga9aa8c572abe57e4552a86bdf06e5c8e8">More...</a><br/></td></tr>
<tr class="separator:ga9aa8c572abe57e4552a86bdf06e5c8e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a33713333b1180a603f9a14fb4243125d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_SLR_INDEX_0&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 0. </p>

</div>
</div>
<a class="anchor" id="a6f65b07d28e9fa31f5179138e519e7e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_SLR_INDEX_1&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 1. </p>

</div>
</div>
<a class="anchor" id="a29170505c98ef8134085f3b106341d9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_SLR_INDEX_2&#160;&#160;&#160;(2U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 2. </p>

</div>
</div>
<a class="anchor" id="ae1d85fe274333fdd2cfe49fab897df2d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_SLR_INDEX_3&#160;&#160;&#160;(3U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>SLR Index 3. </p>

<p>Referenced by <a class="el" href="group__xilplmi__client__apis.html#ga9aa8c572abe57e4552a86bdf06e5c8e8">XPlmi_InputSlrIndex()</a>.</p>

</div>
</div>
<a class="anchor" id="ab1f20993bdf14a739d6c75cc390d9c92"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPLMI_SLR_INDEX_SHIFT&#160;&#160;&#160;(6U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>&lt; shift constant to place slr id </p>
<p>SlrIndexs constants </p>

<p>Referenced by <a class="el" href="group__xilplmi__client__apis.html#ga41f2113dce651f9b36a2abefa10be64c">XPlmi_EventLogging()</a>, and <a class="el" href="group__xilplmi__server__apis.html#ga09694a4b8467a90ed7afdda529d5f721">XPlmi_SendIpiCmdToSlaveSlr()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
